package com.seu.githubcn.config;

/**
 * 表示一次请求响应的类，由响应状态码、响应说明、响应载荷组成，
 * 用于 {@code RESTful Controllers} 接口的响应。
 * 会被编码为 JSON 格式返回给前端。
 * @param <T> 响应载荷的类型，即本次请求操作所获取的数据的类型。
 */
public class Result<T> {
    private int code;
    private T data;
    private String msg;

    /**
     * 获取本次请求的状态代码。
     * @return 状态代码。0 表示请求正常完成，否则请求未正常完成。
     */
    public int getCode() {
        return code;
    }

    /**
     * 设置请求的状态代码。
     * @param code 状态代码。0 表示正常完成，否则请求未正常完成。
     */
    public void setCode(int code) {
        this.code = code;
    }

    /**
     * 获取请求响应载荷。
     * @return 请求响应载荷。
     */
    public T getData() {
        return data;
    }

    /**
     * 设置请求响应载荷。
     * @param data 请求响应载荷。
     */
    public void setData(T data) {
        this.data = data;
    }

    /**
     * 获取请求响应说明。
     * @return 请求响应说明。
     */
    public String getMsg() {
        return msg;
    }

    /**
     * 设置请求响应说明。
     * @param msg 请求响应说明。
     */
    public void setMsg(String msg) {
        this.msg = msg;
    }

    /**
     * 默认构造函数。
     */
    public Result() {
    }

    /**
     * 构造函数，设置所有字段。
     * @param code 状态代码。
     * @param data 响应载荷。
     * @param msg 状态说明。
     */
    public Result (int code, T data, String msg){
        this.code = code;
        this.data=data;
        this.msg=msg;
    }

    /**
     * 构造并返回一个无载荷的，状态为成功的响应。
     * @return 新构造的响应。
     */
    public static Result success() {
        Result result = new Result<>();
        result.setCode(200);
        result.setMsg("成功");
        return result;
    }

    /**
     * 构造并返回一个有载荷的，状态为成功的响应。
     * @param <T> 响应载荷的类型。
     * @param data 响应的载荷。
     * @return 新构造的响应。
     */
    public static <T> Result<T> success(T data) {
        Result<T> result = new Result<>();
        result.setData(data);
        result.setCode(200);
        result.setMsg("成功");
        return result;
    }

    /**
     * 构造并返回一个状态为错误的响应，并设置状态码和状态说明。
     * @param code 状态码。应为非 0 值。
     * @param msg 状态说明，解释发生了什么错误。
     * @return 新构造的响应。
     */
    public static Result error(int code, String msg) {
        Result result = new Result();
        result.setCode(code);
        result.setMsg(msg);
        return result;
    }
}
